Clarify documentation header about GTK+ 3 vs 2
authorColin Walters <walters@verbum.org>
Thu, 27 Jan 2011 16:19:51 +0000 (11:19 -0500)
committerColin Walters <walters@verbum.org>
Thu, 27 Jan 2011 16:32:55 +0000 (11:32 -0500)
I think it's confusing for a lot the developers out there who
may not even be aware of GTK+ 3 coming, if suddenly GTK+ 3 becomes
the "stable" version of "gtk" on library.gnome.org.  It may
not even be feasible for them to port to GTK+3 if it's not
shipped in the operating systems they're targeting (for example,
RHEL 6).

Since practically speaking, we expect people to consume GTK+ 2 for
several years at least, redirect these people to the right pages.

(I didn't attempt to explain the differences between the libraries
 here, but hopefully the major version difference is enough of a hint)

As a side effect, this makes the generated HTML look better; previously
it looked rather crappy, since the "for GTK &version;" was totally
offset and in a different group from the documentation title.

docs/reference/gtk/gtk-docs.sgml

index 9f57e97057d5924a114e5584e9b096066424ea45..0274da7a8f0d1fde06bfd61dcf2f8914a88f0d25 100644 (file)
@@ -8,11 +8,11 @@
 ]>
 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   <bookinfo>
-    <title>GTK+ Reference Manual</title>
+    <title>GTK+ Reference Manual</title>
     <releaseinfo>
-      for GTK+ &version;
-      The latest version of this documentation can be found on-line at
-      <ulink role="online-location" url="http://library.gnome.org/devel/gtk/unstable/">http://library.gnome.org/devel/gtk/unstable/</ulink>.
+      This document is for GTK+ 3 library; the latest version can be found online at
+      <ulink role="online-location" url="http://library.gnome.org/devel/gtk/unstable/">http://library.gnome.org/devel/gtk/unstable/</ulink>.  
+      If you're looking for the older GTK+ 2 series of libraries, they can be found under their version numbers; for example, 2.22 is available at <ulink role="online-location" url="http://library.gnome.org/devel/gtk/2.22/">http://library.gnome.org/devel/gtk/2.22/</ulink>.
     </releaseinfo>
   </bookinfo>